<!--
  This file is a part of the open-eBackup project.
  This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
  If a copy of the MPL was not distributed with this file, You can obtain one at
  http://mozilla.org/MPL/2.0/.
  
  Copyright (c) [2024] Huawei Technologies Co.,Ltd.
  
  THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
  EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
  MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
  -->


<!DOCTYPE html
  PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
      <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="DC.Type" content="topic">
<meta name="DC.Title" content="Preparing for the Backup">
<meta name="product" content="">
<meta name="DC.Relation" scheme="URI" content="clickhouse-0003.html">
<meta name="prodname" content="">
<meta name="version" content="">
<meta name="brand" content="30-OceanProtect Appliance 1.5.0-1.6.0 Help Center">
<meta name="DC.Publisher" content="20241029">
<meta name="prodname" content="csbs">
<meta name="documenttype" content="usermanual">
<meta name="DC.Format" content="XHTML">
<meta name="DC.Identifier" content="clickhouse-0006">
<meta name="DC.Language" content="en-us">
<link rel="stylesheet" type="text/css" href="public_sys-resources/commonltr.css">
<title>Preparing for the Backup</title>
</head>
<body style="clear:both; padding-left:10px; padding-top:5px; padding-right:5px; padding-bottom:5px"><a name="clickhouse-0006"></a><a name="clickhouse-0006"></a>

<h1 class="topictitle1">Preparing for the Backup</h1>
<div><p id="clickhouse-0006__en-us_topic_0000001514245969_p2081519408348">Before backing up the ClickHouse, prepare related information as follows:</p>
<ul id="clickhouse-0006__en-us_topic_0000001514245969_ul7979115714229"><li id="clickhouse-0006__en-us_topic_0000001514245969_li1797985712226"><a href="#clickhouse-0006__en-us_topic_0000001514245969_table481544017344">Table 1</a> lists the information required.</li><li id="clickhouse-0006__en-us_topic_0000001514245969_li845912218181"><a href="#clickhouse-0006__en-us_topic_0000001514245969_table163117288184">Table 2</a> lists the information required when the authentication mode for communication between the ClickHouse cluster and <span id="clickhouse-0006__en-us_topic_0000001514245969_text17560149162013">OceanProtect Appliance</span> is <span class="uicontrol" id="clickhouse-0006__en-us_topic_0000001514245969_uicontrol5560139122017"><b><span id="clickhouse-0006__en-us_topic_0000001514245969_text17170155211207"><strong>Database authentication</strong></span></b></span>.</li><li id="clickhouse-0006__en-us_topic_0000001514245969_li2131135452316"><a href="#clickhouse-0006__en-us_topic_0000001514245969_table8758104318915">Table 3</a> lists the information required when the authentication mode for communication between the ClickHouse cluster and <span id="clickhouse-0006__en-us_topic_0000001514245969_text625461015249">OceanProtect Appliance</span> is <span class="uicontrol" id="clickhouse-0006__en-us_topic_0000001514245969_en-us_topic_0000001249935107_uicontrol2521112115915"><b><span id="clickhouse-0006__en-us_topic_0000001514245969_text18552124710171"><strong>Kerberos Authentication</strong></span></b></span>.</li></ul>

<div class="tablenoborder"><a name="clickhouse-0006__en-us_topic_0000001514245969_table481544017344"></a><a name="en-us_topic_0000001514245969_table481544017344"></a><table cellpadding="4" cellspacing="0" summary="" id="clickhouse-0006__en-us_topic_0000001514245969_table481544017344" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Preparing for the backup</caption><colgroup><col style="width:18.310000000000002%"><col style="width:14.62%"><col style="width:50.73%"><col style="width:16.34%"></colgroup><thead align="left"><tr id="clickhouse-0006__en-us_topic_0000001514245969_row9816154073414"><th align="left" class="cellrowborder" valign="top" width="18.310000000000002%" id="mcps1.3.3.2.5.1.1"><p id="clickhouse-0006__en-us_topic_0000001514245969_p981620401348">Item</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.62%" id="mcps1.3.3.2.5.1.2"><p id="clickhouse-0006__en-us_topic_0000001514245969_p88162405347">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.73%" id="mcps1.3.3.2.5.1.3"><p id="clickhouse-0006__en-us_topic_0000001514245969_p0816740133411">How to Obtain</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.34%" id="mcps1.3.3.2.5.1.4"><p id="clickhouse-0006__en-us_topic_0000001514245969_p12816114013349">Section</p>
</th>
</tr>
</thead>
<tbody><tr id="clickhouse-0006__en-us_topic_0000001514245969_row7931412142811"><td class="cellrowborder" valign="top" width="18.310000000000002%" headers="mcps1.3.3.2.5.1.1 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p520619903511">MRS cluster <span id="clickhouse-0006__en-us_topic_0000001514245969_text1623101615421"><strong>Client installation path</strong></span></p>
</td>
<td class="cellrowborder" valign="top" width="14.62%" headers="mcps1.3.3.2.5.1.2 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p20932012152814">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50.73%" headers="mcps1.3.3.2.5.1.3 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p17351131416350">Obtain the item from the MRS cluster administrator.</p>
</td>
<td class="cellrowborder" rowspan="2" valign="top" width="16.34%" headers="mcps1.3.3.2.5.1.4 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p281674012347"><a href="clickhouse-0008.html">Step 1: Registering a ClickHouse Cluster</a></p>
<p id="clickhouse-0006__en-us_topic_0000001514245969_p826818361517"></p>
<p id="clickhouse-0006__en-us_topic_0000001514245969_p10237131512158"></p>
</td>
</tr>
<tr id="clickhouse-0006__en-us_topic_0000001514245969_row172673318151"><td class="cellrowborder" valign="top" headers="mcps1.3.3.2.5.1.1 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p42678301512">ClickHouse service IP address</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.2.5.1.2 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p61129261152">Yes</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.2.5.1.3 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p6268439156">Obtain the item from the MRS cluster administrator.</p>
</td>
</tr>
</tbody>
</table>
</div>

<div class="tablenoborder"><a name="clickhouse-0006__en-us_topic_0000001514245969_table163117288184"></a><a name="en-us_topic_0000001514245969_table163117288184"></a><table cellpadding="4" cellspacing="0" summary="" id="clickhouse-0006__en-us_topic_0000001514245969_table163117288184" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Information required for database authentication</caption><colgroup><col style="width:22.220000000000002%"><col style="width:10.52%"><col style="width:42.26%"><col style="width:25%"></colgroup><thead align="left"><tr id="clickhouse-0006__en-us_topic_0000001514245969_row1831192851818"><th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.4.2.5.1.1"><p id="clickhouse-0006__en-us_topic_0000001514245969_p4771532171813">Item</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.52%" id="mcps1.3.4.2.5.1.2"><p id="clickhouse-0006__en-us_topic_0000001514245969_p207718327184">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42.26%" id="mcps1.3.4.2.5.1.3"><p id="clickhouse-0006__en-us_topic_0000001514245969_p6771153213186">How to Obtain</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.5.1.4"><p id="clickhouse-0006__en-us_topic_0000001514245969_p147717324182">Section</p>
</th>
</tr>
</thead>
<tbody><tr id="clickhouse-0006__en-us_topic_0000001514245969_row153114287186"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.5.1.1 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p19311162817181">Database user name and password</p>
</td>
<td class="cellrowborder" valign="top" width="10.52%" headers="mcps1.3.4.2.5.1.2 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p18311228181813">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="42.26%" headers="mcps1.3.4.2.5.1.3 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p13670113118354">Obtain the item from the MRS cluster administrator.</p>
<div class="note" id="clickhouse-0006__en-us_topic_0000001514245969_note1575172716367"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="clickhouse-0006__en-us_topic_0000001514245969_p83111028181813">Enter the name of a user having the read and write permissions on the protected resources.</p>
</div></div>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.5.1.4 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p33111228101818"><a href="clickhouse-0008.html">Step 1: Registering a ClickHouse Cluster</a></p>
</td>
</tr>
</tbody>
</table>
</div>

<div class="tablenoborder"><a name="clickhouse-0006__en-us_topic_0000001514245969_table8758104318915"></a><a name="en-us_topic_0000001514245969_table8758104318915"></a><table cellpadding="4" cellspacing="0" summary="" id="clickhouse-0006__en-us_topic_0000001514245969_table8758104318915" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Information required for Kerberos authentication</caption><colgroup><col style="width:19.41%"><col style="width:13.52%"><col style="width:50.73%"><col style="width:16.34%"></colgroup><thead align="left"><tr id="clickhouse-0006__en-us_topic_0000001514245969_row275817435910"><th align="left" class="cellrowborder" valign="top" width="19.41%" id="mcps1.3.5.2.5.1.1"><p id="clickhouse-0006__en-us_topic_0000001514245969_p575816432098">Item</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.52%" id="mcps1.3.5.2.5.1.2"><p id="clickhouse-0006__en-us_topic_0000001514245969_p175812433916">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.73%" id="mcps1.3.5.2.5.1.3"><p id="clickhouse-0006__en-us_topic_0000001514245969_p1475874317915">How to Obtain</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.34%" id="mcps1.3.5.2.5.1.4"><p id="clickhouse-0006__en-us_topic_0000001514245969_p1375811431914">Section</p>
</th>
</tr>
</thead>
<tbody><tr id="clickhouse-0006__en-us_topic_0000001514245969_row37593434911"><td class="cellrowborder" valign="top" width="19.41%" headers="mcps1.3.5.2.5.1.1 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p187592432916">Principal name of Kerberos authentication</p>
</td>
<td class="cellrowborder" valign="top" width="13.52%" headers="mcps1.3.5.2.5.1.2 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p075917431096">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50.73%" headers="mcps1.3.5.2.5.1.3 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p975944315912">Obtain the principal name from the Kerberos server administrator.</p>
<div class="note" id="clickhouse-0006__en-us_topic_0000001514245969_note164812228597"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="clickhouse-0006__en-us_topic_0000001514245969_p875118419379">The principal name must have the management permissions on the resource to be accessed.</p>
</div></div>
</td>
<td class="cellrowborder" rowspan="4" valign="top" width="16.34%" headers="mcps1.3.5.2.5.1.4 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p375910437911"><a href="clickhouse-0008.html">Step 1: Registering a ClickHouse Cluster</a></p>
<p id="clickhouse-0006__en-us_topic_0000001514245969_p5759204319919"></p>
<p id="clickhouse-0006__en-us_topic_0000001514245969_p77591143391"></p>
<p id="clickhouse-0006__en-us_topic_0000001514245969_p15954184312167"></p>
<p id="clickhouse-0006__en-us_topic_0000001514245969_p357614615199"></p>
</td>
</tr>
<tr id="clickhouse-0006__en-us_topic_0000001514245969_row167594436911"><td class="cellrowborder" valign="top" headers="mcps1.3.5.2.5.1.1 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p5759174313916"><span class="filepath" id="clickhouse-0006__en-us_topic_0000001514245969_filepath10442111771912"><b>.conf</b></span> configuration file (for example, <strong id="clickhouse-0006__en-us_topic_0000001514245969_b8442151712197">krb5.conf</strong>) used during Kerberos authentication</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.5.2.5.1.2 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p37590431398">Yes</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.5.2.5.1.3 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p4759104317912">Contact the Kerberos server administrator to obtain the file from the Kerberos server.</p>
</td>
</tr>
<tr id="clickhouse-0006__en-us_topic_0000001514245969_row67599432918"><td class="cellrowborder" valign="top" headers="mcps1.3.5.2.5.1.1 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p27594439920">Password of the principal name</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.5.2.5.1.2 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p11759194314913">No</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.5.2.5.1.3 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p575920436910">If Kerberos authentication is performed using a password, you need to obtain the password of the principal name.</p>
</td>
</tr>
<tr id="clickhouse-0006__en-us_topic_0000001514245969_row8953154391615"><td class="cellrowborder" valign="top" headers="mcps1.3.5.2.5.1.1 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p199534434164"><strong id="clickhouse-0006__en-us_topic_0000001514245969_b04181614142019">.keytab</strong> file</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.5.2.5.1.2 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p15954164312164">No</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.5.2.5.1.3 "><p id="clickhouse-0006__en-us_topic_0000001514245969_p134735251717">If Kerberos authentication is performed using a <strong id="clickhouse-0006__en-us_topic_0000001514245969_b76226315202">keytab</strong> file, you need to obtain the <strong id="clickhouse-0006__en-us_topic_0000001514245969_b095762619203">.keytab</strong> file.</p>
<p id="clickhouse-0006__en-us_topic_0000001514245969_p718013217174">Contact the Kerberos server administrator to obtain the file from the Kerberos server.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="clickhouse-0003.html">Backup</a></div>
</div>
</div>

<div class="hrcopyright"><hr size="2"></div><div class="hwcopyright">Copyright &copy; Huawei Technologies Co., Ltd.</div></body>
</html>